/*-
 * Copyright (c) 2006, 2007 FTS Team
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the FTS Team nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      BaseParser.hpp
 *
 * $FTS$
 */
#ifndef _BASE_PARSER_HPP__
#define _BASE_PARSER_HPP__ 1

/**
  @file BaseParser.hpp
  @brief Base document parser
*/

// C includes
#ifdef _DEBUG
  #include <stdio.h>
#endif

// Local Includes
#include <Types.h>

namespace FTSS // FullTextSearchSystem
{
// FWD
class Indexer;
class DocumentStorage;
class LemCache;

/**
  @class BaseParser BaseParser.hpp <BaseParser.hpp>
  @brief Base parser class
*/
class BaseParser
{
public:
	/**
	  @brief Store inverted index handler and document storage
	  @param pIndexer - indexer
	  @param pDocumentStorage - document storage
	  @param pLemCache - lemmatizer cache
	  @return 0 if success, -1 if any error occured
	*/
	virtual INT_32 SetHandlers(Indexer * pIndexer, DocumentStorage * pDocumentStorage, LemCache * pLemCache) throw() = 0;

	/**
	  @brief Parse part of document
	  @param sText - text to parse
	  @param iTextLength - size of text
	  @return 0 if success, -1 if any error occured
	*/
	virtual INT_32 ParseChunk(CCHAR_P sText, const UINT_32 & iTextLength) throw() = 0;

	/**
	  @brief Start new document
	  @param sDocName - name of document
	  @param iDocnameLength - document length
	  @return 0 if success, -1 if any error occured
	*/
	virtual INT_32 StartDocument(CCHAR_P sDocName, const UINT_32 & iDocnameLength) throw() = 0;

	/**
	  @brief End current document
	  @return 0 if success, -1 if any error occured
	*/
	virtual INT_32 EndDocument() throw() = 0;

	/**
	  @brief Get current token position
	  @return current token position
	*/
	virtual INT_32 GetTokenPos() throw() = 0;

	/**
	  @brief A destructor
	*/
	virtual ~BaseParser() throw() { ;; }
};

} // namespace FTSS
#endif // _BASE_PARSER_HPP__
// End.
